home *** CD-ROM | disk | FTP | other *** search
/ Total Network Tools 2002 / NextStepPublishing-TotalNetworkTools2002-Win95.iso / Archive / Misc Servers / Zope.exe / PROPERTYSHEET.PY < prev    next >
Encoding:
Text File  |  2000-10-31  |  9.9 KB  |  300 lines
  1. ##############################################################################
  2. # 
  3. # Zope Public License (ZPL) Version 1.0
  4. # -------------------------------------
  5. # 
  6. # Copyright (c) Digital Creations.  All rights reserved.
  7. # 
  8. # This license has been certified as Open Source(tm).
  9. # 
  10. # Redistribution and use in source and binary forms, with or without
  11. # modification, are permitted provided that the following conditions are
  12. # met:
  13. # 
  14. # 1. Redistributions in source code must retain the above copyright
  15. #    notice, this list of conditions, and the following disclaimer.
  16. # 
  17. # 2. Redistributions in binary form must reproduce the above copyright
  18. #    notice, this list of conditions, and the following disclaimer in
  19. #    the documentation and/or other materials provided with the
  20. #    distribution.
  21. # 
  22. # 3. Digital Creations requests that attribution be given to Zope
  23. #    in any manner possible. Zope includes a "Powered by Zope"
  24. #    button that is installed by default. While it is not a license
  25. #    violation to remove this button, it is requested that the
  26. #    attribution remain. A significant investment has been put
  27. #    into Zope, and this effort will continue if the Zope community
  28. #    continues to grow. This is one way to assure that growth.
  29. # 
  30. # 4. All advertising materials and documentation mentioning
  31. #    features derived from or use of this software must display
  32. #    the following acknowledgement:
  33. # 
  34. #      "This product includes software developed by Digital Creations
  35. #      for use in the Z Object Publishing Environment
  36. #      (http://www.zope.org/)."
  37. # 
  38. #    In the event that the product being advertised includes an
  39. #    intact Zope distribution (with copyright and license included)
  40. #    then this clause is waived.
  41. # 
  42. # 5. Names associated with Zope or Digital Creations must not be used to
  43. #    endorse or promote products derived from this software without
  44. #    prior written permission from Digital Creations.
  45. # 
  46. # 6. Modified redistributions of any form whatsoever must retain
  47. #    the following acknowledgment:
  48. # 
  49. #      "This product includes software developed by Digital Creations
  50. #      for use in the Z Object Publishing Environment
  51. #      (http://www.zope.org/)."
  52. # 
  53. #    Intact (re-)distributions of any official Zope release do not
  54. #    require an external acknowledgement.
  55. # 
  56. # 7. Modifications are encouraged but must be packaged separately as
  57. #    patches to official Zope releases.  Distributions that do not
  58. #    clearly separate the patches from the original work must be clearly
  59. #    labeled as unofficial distributions.  Modifications which do not
  60. #    carry the name Zope may be packaged in any form, as long as they
  61. #    conform to all of the clauses above.
  62. # 
  63. # 
  64. # Disclaimer
  65. # 
  66. #   THIS SOFTWARE IS PROVIDED BY DIGITAL CREATIONS ``AS IS'' AND ANY
  67. #   EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  68. #   IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  69. #   PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL DIGITAL CREATIONS OR ITS
  70. #   CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  71. #   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  72. #   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  73. #   USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  74. #   ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  75. #   OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  76. #   OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  77. #   SUCH DAMAGE.
  78. # 
  79. # 
  80. # This software consists of contributions made by Digital Creations and
  81. # many individuals on behalf of Digital Creations.  Specific
  82. # attributions are listed in the accompanying credits file.
  83. # 
  84. ##############################################################################
  85.  
  86. class PropertySheet:
  87.     """
  88.  
  89.     A PropertySheet is an abstraction for organizing and working
  90.     with a set of related properties. Conceptually it acts like a
  91.     container for a set of related properties and meta-data describing 
  92.     those properties. A PropertySheet may or may not provide a web 
  93.     interface for managing its properties.
  94.  
  95.     """
  96.  
  97.     def xml_namespace():
  98.         """
  99.  
  100.         Return a namespace string usable as an xml namespace
  101.         for this property set. This may be an empty string if 
  102.         there is no default namespace for a given property sheet
  103.         (especially property sheets added in ZClass definitions).
  104.  
  105.         Permission -- Python only
  106.  
  107.         """
  108.  
  109.     def getProperty(id, d=None):
  110.         """
  111.  
  112.         Get the property 'id', returning the optional second 
  113.         argument or None if no such property is found.
  114.  
  115.         Permission -- Python only
  116.         
  117.         """
  118.  
  119.     def getPropertyType(id):
  120.         """
  121.         
  122.         Get the type of property 'id'. Returns None if no such
  123.         property exists.
  124.  
  125.         Permission -- Python only
  126.         
  127.         """
  128.  
  129.     def hasProperty(id):
  130.         """
  131.  
  132.         Returns true if 'self' has a property with the given 'id', 
  133.         false otherwise.
  134.  
  135.         Permission -- 'Access contents information'
  136.  
  137.         """
  138.  
  139.     def propertyIds():
  140.         """
  141.  
  142.         Returns a list of property ids.
  143.  
  144.         Permission --  'Access contents information'
  145.  
  146.         """
  147.  
  148.     def propertyValues():
  149.         """
  150.  
  151.         Returns a list of actual property values.
  152.  
  153.         Permission -- 'Access contents information'
  154.  
  155.         """
  156.  
  157.     def propertyItems():
  158.         """
  159.  
  160.         Return a list of (id, property) tuples.
  161.  
  162.         Permission -- 'Access contents information'
  163.  
  164.         """
  165.         
  166.     def propertyMap():
  167.         """
  168.  
  169.         Returns a tuple of mappings, giving meta-data for properties.
  170.  
  171.         Perimssion -- Python only
  172.  
  173.         """
  174.  
  175.     def propertyInfo():
  176.         """
  177.  
  178.         Returns a mapping containing property meta-data.
  179.  
  180.         Permission -- Python only
  181.  
  182.         """
  183.  
  184.     def manage_addProperty(id, value, type, REQUEST=None):
  185.         """
  186.  
  187.         Add a new property with the given 'id', 'value' and 'type'.
  188.  
  189.         Property Types
  190.  
  191.           'boolean' -- 1 or 0. 
  192.  
  193.           'date' -- A 'DateTime' value, for example '12/31/1999 15:42:52 PST'.
  194.  
  195.           'float' -- A decimal number, for example '12.4'. 
  196.  
  197.           'int' -- An integer number, for example, '12'. 
  198.  
  199.           'lines' -- A list of strings, one per line. 
  200.  
  201.           'long' -- A long integer, for example '12232322322323232323423'. 
  202.  
  203.           'string' -- A string of characters, for example 'This is a string'. 
  204.  
  205.           'text' -- A multi-line string, for example a paragraph. 
  206.  
  207.           'tokens' -- A list of strings separated by white space, for example
  208.           'one two three'. 
  209.  
  210.           'selection' -- A string selected by a pop-up menu. 
  211.  
  212.           'multiple selection' -- A list of strings selected by a selection list.
  213.  
  214.         This method will use the passed in 'type' to try to convert
  215.         the 'value' argument to the named type. If the given 'value'
  216.         cannot be converted, a ValueError will be raised.
  217.  
  218.         The value given for 'selection' and 'multiple selection'
  219.         properites must be a variable name.  The variable must also be
  220.         a sequence.
  221.  
  222.         *If the given 'type' is not recognized, the 'value' and 'type'
  223.         given are simply stored blindly by the object. This seems like
  224.         bad behavior - it should probably raise an exception instead.*
  225.  
  226.         If no value is passed in for 'REQUEST', the method will return
  227.         'None'. If a value is provided for 'REQUEST' (as it will when
  228.         called via the web), the property management form for the
  229.         object will be rendered and returned.
  230.  
  231.         This method may be called via the web, from DTML or from
  232.         Python code.
  233.  
  234.         Permission -- 'Manage Properties'
  235.  
  236.         """
  237.  
  238.     def manage_changeProperties(REQUEST=None, **kw):
  239.         """
  240.  
  241.         Change existing object properties by passing either a mapping 
  242.         object as 'REQUEST' containing name:value pairs or by passing 
  243.         name=value keyword arguments.
  244.  
  245.         Some objects have "special" properties defined by product 
  246.         authors that cannot be changed. If you try to change one of 
  247.         these properties through this method, an error will be raised.
  248.  
  249.         Note that no type checking or conversion happens when this 
  250.         method is called, so it is the caller's responsibility to 
  251.         ensure that the updated values are of the correct type. 
  252.         *This should probably change*.
  253.  
  254.         If a value is provided for 'REQUEST' (as it will be when
  255.         called via the web), the method will return an HTML message
  256.         dialog. If no REQUEST is passed, the method returns 'None' on
  257.         success.
  258.  
  259.         This method may be called via the web, from DTML or from
  260.         Python code.
  261.  
  262.         Permission - 'Manage Properties'
  263.  
  264.         """
  265.  
  266.  
  267.     def manage_delProperties(ids=None, REQUEST=None):
  268.         """
  269.  
  270.         Delete one or more properties with the given 'ids'. The 'ids' 
  271.         argument should be a sequence (tuple or list) containing the 
  272.         ids of the properties to be deleted. If 'ids' is empty no 
  273.         action will be taken. If any of the properties named in 'ids' 
  274.         does not exist, an error will be raised. 
  275.  
  276.         Some objects have "special" properties defined by product
  277.         authors that cannot be deleted. If one of these properties is
  278.         named in 'ids', an HTML error message is returned (this is
  279.         lame and should be changed).
  280.  
  281.         If no value is passed in for 'REQUEST', the method will return
  282.         None. If a value is provided for 'REQUEST' (as it will be when
  283.         
  284.         called via the web), the property management form for the
  285.         object will be rendered and returned.
  286.  
  287.         This method may be called via the web, from DTML or from
  288.         Python code.
  289.  
  290.         Permission - 'Manage Properties'
  291.  
  292.         """
  293.  
  294.  
  295.  
  296.  
  297.  
  298.  
  299.  
  300.